webkit_remote 0.5.5 → 0.6.0

data/lib/webkit_remote/process.rb

@@ -1,6 +1,5 @@
 require 'fileutils'
 require 'net/http'
-require 'posix/spawn'
 require 'tmpdir'
 
 module WebkitRemote
@@ -17,13 +16,11 @@ class Process
   # @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
   # @option opts [Boolean] allow_popups when true, the popup blocker is
   #     disabled; this is sometimes necessary when driving a Web UI via
   #     JavaScript
+  # @option opts [Boolean] headless if true, Chrome runs without any dependency
+  #     on a display server
   # @option opts [String] chrome_binary path to the Chrome binary to be used;
   #     by default, the path is automatically detected
   def initialize(opts = {})
@@ -32,21 +29,11 @@ class Process
     @running = false
     @data_dir = Dir.mktmpdir 'webkit-remote'
     @pid = nil
-    @xvfb_pid = nil
     if opts[:window]
       @window = opts[:window]
     else
       @window = { }
     end
-    if opts[:xvfb]
-      @xvfb_cli = xvfb_cli opts
-      if opts[:xvfb].respond_to? :[]
-        @window[:width] ||= opts[:xvfb][:width]
-        @window[:height] ||= opts[:xvfb][:height]
-      end
-    else
-      @xvfb_cli = nil
-    end
     @window[:top] ||= 0
     @window[:left] ||= 0
     @window[:width] ||= 256
@@ -62,14 +49,7 @@ class Process
   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)
+    unless @pid = ::Process.spawn(*@cli)
       # The launch failed.
       stop
       return nil
@@ -78,7 +58,7 @@ class Process
     (@timeout * 20).times do
       # Check if the browser exited.
       begin
-        break if status = ::Process.wait(@pid, ::Process::WNOHANG)
+        break if ::Process.wait(@pid, ::Process::WNOHANG)
       rescue SystemCallError  # no children
         break
       end
@@ -119,18 +99,7 @@ class Process
       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)
+    FileUtils.rm_rf @data_dir if File.exist?(@data_dir)
     @running = false
     self
   end
@@ -140,7 +109,7 @@ class Process
 
   # Remove temporary directory if it's still there at garbage collection time.
   def finalize
-    PathUtils.rm_rf @data_dir if File.exists?(@data_dir)
+    PathUtils.rm_rf @data_dir if File.exist?(@data_dir)
   end
 
   # Command-line that launches Google Chrome / Chromium
@@ -151,7 +120,6 @@ class Process
     # The Chromium wiki recommends this page for available flags:
     #     http://peter.sh/experiments/chromium-command-line-switches/
     [
-      chrome_env(opts),
       opts[:chrome_binary] || self.class.chrome_binary,
     ] + chrome_cli_flags(opts) + [
       "--remote-debugging-port=#{@port}",  # Webkit remote debugging
@@ -164,7 +132,8 @@ class Process
         chdir: @data_dir,
         in: '/dev/null',
         out: File.join(@data_dir, '.stdout'),
-        err: File.join(@data_dir, '.stderr')
+        err: File.join(@data_dir, '.stderr'),
+        close_others: true,
       },
     ]
   end
@@ -174,11 +143,12 @@ class Process
   # @param [Hash] opts options passed to the WebkitRemote::Process constructor
   # @return [Array<String>] flags used on the command line for launching Chrome
   def chrome_cli_flags(opts)
+    # TODO - look at --data-path --homedir --profile-directory
     flags = [
       '--bwsi',  # disable extensions, sync, bookmarks
+      '--disable-cloud-import',  # no talking with the Google servers
       '--disable-default-apps',  # no bundled apps
       '--disable-extensions',  # no extensions
-      '--disable-java',  # no plugins
       '--disable-logging',  # don't trash stdout / stderr
       '--disable-plugins',  # no native content
       '--disable-prompt-on-repost',   # no confirmation dialog on POST refresh
@@ -193,73 +163,15 @@ class Process
       '--no-default-browser-check',  # don't hang when Chrome isn't default
       '--no-experiments',  # not sure this is useful
       '--no-first-run',  # don't show the help UI
-      '--no-js-randomness',  # consistent Date.now() and Math.random()
-      '--no-message-box',  # don't let user scripts show dialogs
       '--no-service-autorun',  # don't mess with autorun settings
       '--noerrdialogs',  # don't hang on error dialogs
     ]
     flags << '--disable-popup-blocking' if opts[:allow_popups]
-    flags
-  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 = {}
+    if opts[:headless]
+      flags << '--headless'  # don't create a UI
+      flags << '--disable-gpu'  # needed for --headless to work at the moment
     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'),
-      },
-    ]
+    flags
   end
 
   # Path to a Google Chrome / Chromium binary.
@@ -297,20 +209,6 @@ 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

@@ -8,9 +8,9 @@ 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
+    # Use headless if no desktop is available.
+    if !opts.has_key?(:headless) && (!ENV['DISPLAY'] || ENV['DISPLAY'].empty?)
+      opts = { headless: true }.merge! opts
     end
     process = WebkitRemote::Process.new opts
 

data/test/fixtures/html/input.html

@@ -25,7 +25,7 @@
       };
       var keyEventDetails = function (event) {
         return "keyCode: " + event.keyCode + " charCode: " + event.charCode +
-          " keyIdentifier: " + event.keyIdentifier + " text: " + event.text +
+          " key: " + event.key + " text: " + event.text +
           " repeat: " + event.repeat + " shift: " + event.shiftKey +
           " ctrl: " + event.ctrlKey + " alt: " + event.altKey +
           " meta: " + event.metaKey;
@@ -52,4 +52,3 @@
     </script>
   </body>
 </html>
-

data/test/helper.rb

@@ -17,7 +17,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'webkit_remote'
 
-require 'debugger'
+require 'byebug'
 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, xvfb: true
+    @process = WebkitRemote::Process.new port: 9669, headless: true
     @process.start
   end
   after :each do

data/test/webkit_remote/client/console_test.rb

@@ -26,9 +26,6 @@ describe WebkitRemote::Client::Console do
       lambda {
         @client.wait_for type: WebkitRemote::Event::ConsoleMessage
       }.must_raise ArgumentError
-      lambda {
-        @client.wait_for type: WebkitRemote::Event::ConsoleMessageRepeated
-      }.must_raise ArgumentError
       lambda {
         @client.wait_for type: WebkitRemote::Event::ConsoleCleared
       }.must_raise ArgumentError
@@ -43,9 +40,6 @@ describe WebkitRemote::Client::Console do
       @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
 
@@ -57,30 +51,28 @@ describe WebkitRemote::Client::Console 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
       @messages[0].text.must_equal 'hello ruby'
-      @messages[0].params.must_equal ['hello ruby']
       @messages[0].level.must_equal :warning
-      @messages[0].count.must_equal 1
       @messages[0].reason.must_equal :console_api
-      @messages[0].type.must_equal :log
       @messages[0].source_url.must_equal fixture_url(:console)
       @messages[0].source_line.must_equal 7
+
+      @messages[1].text.must_equal 'stack test'
+      @messages[1].level.must_equal :log
+      @messages[2].text.must_match(/^params /)
+      @messages[2].level.must_equal :error
     end
 
+=begin
+    TODO(pwnall): Stacks are now available in Runtime.consoleAPICalled
     it 'parses the stack trace correctly' do
       @messages[1].text.must_equal 'stack test'
       @messages[1].level.must_equal :log
@@ -92,6 +84,7 @@ describe WebkitRemote::Client::Console do
       ]
     end
 
+    TODO(pwnall): Params are now available as args in Runtime.consoleAPICalled
     it 'parses parameters correctly' do
       @messages[2].text.must_match(/^params /)
       @messages[2].level.must_equal :error
@@ -100,16 +93,11 @@ describe WebkitRemote::Client::Console do
 
       @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
+      @messages[2].params[3].group.name.must_be_nil
     end
+=end
 
+=begin
     describe 'clear_console' do
       before :all do
         @client.clear_console
@@ -135,8 +123,11 @@ describe WebkitRemote::Client::Console do
         @message_events[2].message.params[3].released?.must_equal true
       end
     end
+=end
   end
 
+=begin
+  TODO(pwnall): These events are now available as Log.entryAdded
   describe 'with console and network events enabled' do
     before :all do
       @client.console_events = true
@@ -159,7 +150,7 @@ describe WebkitRemote::Client::Console do
     end
 
     it 'associates messages with network requests' do
-      @messages[0].text.must_match /not found/i
+      @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)
@@ -169,4 +160,5 @@ describe WebkitRemote::Client::Console do
       @messages[0].type.must_equal :log
     end
   end
+=end
 end

data/test/webkit_remote/client/dom_test.rb

@@ -57,7 +57,7 @@ describe WebkitRemote::Client::DomNode do
     describe 'with a selector that does not match' do
       it 'returns nil' do
         node = @root.query_selector '#this-id-should-not-exist'
-        node.must_equal nil
+        node.must_be_nil
       end
     end
   end

data/test/webkit_remote/client/input_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../helper.rb', File.dirname(__FILE__))
 
-describe WebkitRemote::Client::Console do
+describe WebkitRemote::Client::Input do
   before :all do
     @client = WebkitRemote.local port: 9669
     @client.page_events = true
@@ -12,6 +12,7 @@ describe WebkitRemote::Client::Console do
     @client.close
   end
 
+=begin
   describe '#mouse_event' do
     it 'generates a move correctly' do
       @client.mouse_event :move, 50, 50
@@ -32,12 +33,12 @@ describe WebkitRemote::Client::Console do
     end
 
     it 'generates a second press correctly' do
-      @client.mouse_event :down, 51, 52, button: :left, clicks: 2,
+      @client.mouse_event :down, 51, 52, button: :right, clicks: 2,
                           modifiers: [:alt, :ctrl]
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'Down. x: 51 y: 52 button: 0 detail: 2 shift: false ctrl: true ' +
+          'Down. x: 51 y: 52 button: 2 detail: 2 shift: false ctrl: true ' +
           'alt: true meta: false')
     end
 
@@ -46,10 +47,11 @@ describe WebkitRemote::Client::Console do
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'Up. x: 51 y: 52 button: 0 detail: 0 shift: false ctrl: false ' +
+          'Up. x: 51 y: 52 button: 1 detail: 0 shift: false ctrl: false ' +
           'alt: false meta: true')
     end
   end
+=end
 
   describe '#key_event' do
     it 'generates a char correctly' do
@@ -58,42 +60,38 @@ describe WebkitRemote::Client::Console do
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'KPress. keyCode: 97 charCode: 97 keyIdentifier:  text: undefined ' +
+          'KPress. keyCode: 97 charCode: 97 key:  text: undefined ' +
           'repeat: false shift: false ctrl: false alt: false meta: false')
     end
 
     it 'generates a down correctly' do
-      @client.key_event :down, vkey: 0x41, key_id: 'U+0041'
+      @client.key_event :down, vkey: 0x41, key: 'A'
 
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'KDown. keyCode: 65 charCode: 0 keyIdentifier: U+0041 ' +
-          'text: undefined ' +
+          'KDown. keyCode: 65 charCode: 0 key: A text: undefined ' +
           'repeat: false shift: false ctrl: false alt: false meta: false')
     end
 
     it 'generates an up correctly' do
-      @client.key_event :up, vkey: 0x41, key_id: 'U+0041'
+      @client.key_event :up, vkey: 0x41, key: 'A'
 
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'KUp. keyCode: 65 charCode: 0 keyIdentifier: U+0041 ' +
-          'text: undefined ' +
+          'KUp. keyCode: 65 charCode: 0 key: A text: undefined ' +
           'repeat: false shift: false ctrl: false alt: false meta: false')
     end
 
     it 'generates a raw_down correctly' do
-      @client.key_event :raw_down, vkey: 0x41, key_id: 'U+0041'
+      @client.key_event :raw_down, vkey: 0x41, key: 'A'
 
       events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage
 
       events.last.message.text.must_equal(
-          'KDown. keyCode: 65 charCode: 0 keyIdentifier: U+0041 ' +
-          'text: undefined ' +
+          'KDown. keyCode: 65 charCode: 0 key: A text: undefined ' +
           'repeat: false shift: false ctrl: false alt: false meta: false')
     end
   end
 end
-