capybara-webkit 1.2.0 → 1.3.0

data/lib/capybara/webkit/connection.rb

@@ -35,11 +35,24 @@ module Capybara::Webkit
     end
 
     def gets
-      @socket.gets
+      response = ""
+      until response.match(/\n/) do
+        response += read(1)
+      end
+      response
     end
 
     def read(length)
-      @socket.read(length)
+      response = ""
+      begin
+        while response.length < length do
+          response += @socket.read_nonblock(length - response.length)
+        end
+      rescue IO::WaitReadable
+        Thread.new { IO.select([@socket]) }.join
+        retry
+      end
+      response
     end
 
     private
@@ -55,9 +68,19 @@ module Capybara::Webkit
       @pipe_stdin, @pipe_stdout, @pipe_stderr, @wait_thr = Open3.popen3(SERVER_PATH)
     end
 
+    def parse_port(line)
+      if match = line.to_s.match(/listening on port: (\d+)/)
+        match[1].to_i
+      else
+        raise ConnectionError, "#{SERVER_PATH} failed to start."
+      end
+    end
+
     def discover_port
       if IO.select([@pipe_stdout], nil, nil, WEBKIT_SERVER_START_TIMEOUT)
-        @port = ((@pipe_stdout.first || '').match(/listening on port: (\d+)/) || [])[1].to_i
+        @port = parse_port(@pipe_stdout.first)
+      else
+        raise ConnectionError, "#{SERVER_PATH} failed to start after #{WEBKIT_SERVER_START_TIMEOUT} seconds."
       end
     end
 

data/lib/capybara/webkit/driver.rb

@@ -69,14 +69,22 @@ module Capybara::Webkit
     end
 
     def alert_messages
+      warn '[DEPRECATION] Capybara::Webkit::Driver#alert_messages ' \
+        'is deprecated. Please use Capybara::Session#accept_alert instead.'
       browser.alert_messages
     end
 
     def confirm_messages
+      warn '[DEPRECATION] Capybara::Webkit::Driver#confirm_messages ' \
+        'is deprecated. Please use Capybara::Session#accept_confirm ' \
+        'or Capybara::Session#dismiss_confirm instead.'
       browser.confirm_messages
     end
 
     def prompt_messages
+      warn '[DEPRECATION] Capybara::Webkit::Driver#prompt_messages ' \
+        'is deprecated. Please use Capybara::Session#accept_prompt ' \
+        'or Capybara::Session#dismiss_prompt instead.'
       browser.prompt_messages
     end
 
@@ -89,6 +97,8 @@ module Capybara::Webkit
     end
 
     def resize_window(width, height)
+      warn '[DEPRECATION] Capybara::Webkit::Driver#resize_window ' \
+        'is deprecated. Please use Capybara::Window#resize_to instead.'
       resize_window_to(current_window_handle, width, height)
     end
 
@@ -144,22 +154,32 @@ module Capybara::Webkit
     end
 
     def accept_js_confirms!
+      warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_confirms! ' \
+        'is deprecated. Please use Capybara::Session#accept_confirm instead.'
       browser.accept_js_confirms
     end
 
     def dismiss_js_confirms!
+      warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_confirms! ' \
+        'is deprecated. Please use Capybara::Session#dismiss_confirm instead.'
       browser.reject_js_confirms
     end
 
     def accept_js_prompts!
+      warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_prompts! ' \
+        'is deprecated. Please use Capybara::Session#accept_prompt instead.'
       browser.accept_js_prompts
     end
 
     def dismiss_js_prompts!
+      warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_prompts! ' \
+        'is deprecated. Please use Capybara::Session#dismiss_prompt instead.'
       browser.reject_js_prompts
     end
 
     def js_prompt_input=(value)
+      warn '[DEPRECATION] Capybara::Webkit::Driver#js_prompt_input= ' \
+        'is deprecated. Please use Capybara::Session#accept_prompt instead.'
       if value.nil?
         browser.clear_prompt_text
       else
@@ -175,6 +195,38 @@ module Capybara::Webkit
       browser.go_forward
     end
 
+    def accept_modal(type, options={})
+      options = modal_action_options_for_browser(options)
+
+      case type
+      when :confirm
+        id = browser.accept_confirm(options)
+      when :prompt
+        id = browser.accept_prompt(options)
+      else
+        id = browser.accept_alert(options)
+      end
+
+      yield
+
+      find_modal(type, id, options)
+    end
+
+    def dismiss_modal(type, options={})
+      options = modal_action_options_for_browser(options)
+
+      case type
+      when :confirm
+        id = browser.reject_confirm(options)
+      else
+        id = browser.reject_prompt(options)
+      end
+
+      yield
+
+      find_modal(type, id, options)
+    end
+
     def wait?
       true
     end
@@ -217,5 +269,27 @@ module Capybara::Webkit
         browser.version
       ].join("\n")
     end
+
+    private
+
+    def modal_action_options_for_browser(options)
+      if options[:text].is_a?(Regexp)
+        options.merge(text: options[:text].source)
+      else
+        options.merge(text: Regexp.escape(options[:text].to_s))
+      end.merge(original_text: options[:text])
+    end
+
+    def find_modal(type, id, options)
+      Timeout::timeout(options[:wait] || Capybara.default_wait_time) do
+        browser.find_modal(id)
+      end
+    rescue ModalNotFound
+      raise Capybara::ModalNotFound,
+        "Unable to find modal dialog#{" with #{options[:original_text]}" if options[:original_text]}"
+    rescue Timeout::Error
+      raise Capybara::ModalNotFound,
+        "Timed out waiting for modal dialog#{" with #{options[:original_text]}" if options[:original_text]}"
+    end
   end
 end

data/lib/capybara/webkit/errors.rb

@@ -17,6 +17,12 @@ module Capybara::Webkit
   class NoSuchWindowError < StandardError
   end
 
+  class ConnectionError < StandardError
+  end
+
+  class ModalNotFound < StandardError
+  end
+
   class JsonError
     def initialize(response)
       error = JSON.parse response

data/lib/capybara/webkit/version.rb

@@ -1,7 +1,7 @@
 module Capybara
   module Driver
     class Webkit
-      VERSION = '1.2.0'.freeze
+      VERSION = '1.3.0'.freeze
     end
   end
 end

data/spec/connection_spec.rb

@@ -23,6 +23,33 @@ describe Capybara::Webkit::Connection do
     expect { Process.getpgid(webkit_pid) }.to raise_error Errno::ESRCH
   end
 
+  it "raises an error if the server has stopped", skip_on_windows: true do
+    path = 'false'
+    stub_const("Capybara::Webkit::Connection::SERVER_PATH", path)
+
+    expect { Capybara::Webkit::Connection.new }.
+      to raise_error(
+        Capybara::Webkit::ConnectionError,
+        "#{path} failed to start.")
+  end
+
+  it "raises an error if the server is not ready", skip_on_windows: true do
+    server_path = 'sleep 1'
+    stub_const("Capybara::Webkit::Connection::SERVER_PATH", server_path)
+    start_timeout = 0.5
+    stub_const("Capybara::Webkit::Connection::WEBKIT_SERVER_START_TIMEOUT", start_timeout)
+
+    error_string =
+      if defined?(::JRUBY_VERSION)
+        "#{server_path} failed to start."
+      else
+        "#{server_path} failed to start after #{start_timeout} seconds."
+      end
+
+    expect { Capybara::Webkit::Connection.new }.
+      to raise_error(Capybara::Webkit::ConnectionError, error_string)
+  end
+
   it "boots a server to talk to" do
     url = "http://#{@rack_server.host}:#{@rack_server.port}/"
     connection.puts "Visit"

data/spec/driver_spec.rb

@@ -618,28 +618,101 @@ describe Capybara::Webkit::Driver do
   end
 
   context "javascript dialog interaction" do
+    before do
+      stub_const('Capybara::ModalNotFound', Class.new(StandardError))
+    end
+
     context "on an alert app" do
       let(:driver) do
-        driver_for_html(<<-HTML)
-          <html>
-            <head>
-            </head>
-            <body>
-              <script type="text/javascript">
-                alert("Alert Text\\nGoes Here");
-              </script>
-            </body>
-          </html>
-        HTML
+        driver_for_app do
+          get '/' do
+            <<-HTML
+              <html>
+                <head>
+                </head>
+                <body>
+                  <script type="text/javascript">
+                    alert("Alert Text\\nGoes Here");
+                  </script>
+                </body>
+              </html>
+            HTML
+          end
+
+          get '/async' do
+            <<-HTML
+              <html>
+                <head>
+                </head>
+                <body>
+                  <script type="text/javascript">
+                    function testAlert() {
+                      setTimeout(function() { alert("Alert Text\\nGoes Here"); },
+                        #{params[:sleep] || 100});
+                    }
+                  </script>
+                  <input type="button" onclick="testAlert()" name="test"/>
+                </body>
+              </html>
+            HTML
+          end
+        end
       end
 
-      before { visit("/") }
+      it 'accepts any alert modal if no match is provided' do
+        alert_message = driver.accept_modal(:alert) do
+          visit("/")
+        end
+        alert_message.should eq "Alert Text\nGoes Here"
+      end
+
+      it 'accepts an alert modal if it matches' do
+        alert_message = driver.accept_modal(:alert, text: "Alert Text\nGoes Here") do
+          visit("/")
+        end
+        alert_message.should eq "Alert Text\nGoes Here"
+      end
+
+      it 'raises an error when accepting an alert modal that does not match' do
+        expect {
+          driver.accept_modal(:alert, text: 'No?') do
+            visit('/')
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog with No?"
+      end
+
+      it 'waits to accept an async alert modal' do
+        visit("/async")
+        alert_message = driver.accept_modal(:alert) do
+          driver.find_xpath("//input").first.click
+        end
+        alert_message.should eq "Alert Text\nGoes Here"
+      end
+
+      it 'times out waiting for an async alert modal' do
+        visit("/async?sleep=1000")
+        expect {
+          driver.accept_modal(:alert, wait: 0.1) do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Timed out waiting for modal dialog"
+      end
+
+      it 'raises an error when an unexpected modal is displayed' do
+        expect {
+          driver.accept_modal(:confirm) do
+            visit("/")
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog"
+      end
 
       it "should let me read my alert messages" do
+        visit("/")
         driver.alert_messages.first.should eq "Alert Text\nGoes Here"
       end
 
       it "empties the array when reset" do
+        visit("/")
         driver.reset!
         driver.alert_messages.should be_empty
       end
@@ -659,8 +732,25 @@ describe Capybara::Webkit::Driver do
                   else
                     console.log("goodbye");
                 }
+                function test_complex_dialog() {
+                  if(confirm("Yes?"))
+                    if(confirm("Really?"))
+                      console.log("hello");
+                  else
+                    console.log("goodbye");
+                }
+                function test_async_dialog() {
+                  setTimeout(function() {
+                    if(confirm("Yes?"))
+                      console.log("hello");
+                    else
+                      console.log("goodbye");
+                  }, 100);
+                }
               </script>
               <input type="button" onclick="test_dialog()" name="test"/>
+              <input type="button" onclick="test_complex_dialog()" name="test_complex"/>
+              <input type="button" onclick="test_async_dialog()" name="test_async"/>
             </body>
           </html>
         HTML
@@ -668,6 +758,81 @@ describe Capybara::Webkit::Driver do
 
       before { visit("/") }
 
+      it 'accepts any confirm modal if no match is provided' do
+        driver.accept_modal(:confirm) do
+          driver.find_xpath("//input").first.click
+        end
+        driver.console_messages.first[:message].should eq "hello"
+      end
+
+      it 'dismisses a confirm modal that does not match' do
+        begin
+          driver.accept_modal(:confirm, text: 'No?') do
+            driver.find_xpath("//input").first.click
+            driver.console_messages.first[:message].should eq "goodbye"
+          end
+        rescue Capybara::ModalNotFound
+        end
+      end
+
+      it 'raises an error when accepting a confirm modal that does not match' do
+        expect {
+          driver.accept_modal(:confirm, text: 'No?') do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog with No?"
+      end
+
+      it 'dismisses any confirm modal if no match is provided' do
+        driver.dismiss_modal(:confirm) do
+          driver.find_xpath("//input").first.click
+        end
+        driver.console_messages.first[:message].should eq "goodbye"
+      end
+
+      it 'raises an error when dismissing a confirm modal that does not match' do
+        expect {
+          driver.dismiss_modal(:confirm, text: 'No?') do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog with No?"
+      end
+
+      it 'waits to accept an async confirm modal' do
+        visit("/async")
+        confirm_message = driver.accept_modal(:confirm) do
+          driver.find_css("input[name=test_async]").first.click
+        end
+        confirm_message.should eq "Yes?"
+      end
+
+      it 'allows the nesting of dismiss and accept' do
+        driver.dismiss_modal(:confirm) do
+          driver.accept_modal(:confirm) do
+            driver.find_css("input[name=test_complex]").first.click
+          end
+        end
+        driver.console_messages.first[:message].should eq "goodbye"
+      end
+
+      it 'raises an error when an unexpected modal is displayed' do
+        expect {
+          driver.accept_modal(:prompt) do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog"
+      end
+
+      it 'dismisses a confirm modal when prompt is expected' do
+        begin
+          driver.accept_modal(:prompt) do
+            driver.find_xpath("//input").first.click
+            driver.console_messages.first[:message].should eq "goodbye"
+          end
+        rescue Capybara::ModalNotFound
+        end
+      end
+
       it "should default to accept the confirm" do
         driver.find_xpath("//input").first.click
         driver.console_messages.first[:message].should eq "hello"
@@ -727,8 +892,23 @@ describe Capybara::Webkit::Driver do
                   else
                     console.log("goodbye");
                 }
+                function test_complex_dialog() {
+                  var response = prompt("Your name?", "John Smith");
+                  if(response != null)
+                    if(prompt("Your age?"))
+                      console.log("hello " + response);
+                  else
+                    console.log("goodbye");
+                }
+                function test_async_dialog() {
+                  setTimeout(function() {
+                    var response = prompt("Your name?", "John Smith");
+                  }, 100);
+                }
               </script>
               <input type="button" onclick="test_dialog()" name="test"/>
+              <input type="button" onclick="test_complex_dialog()" name="test_complex"/>
+              <input type="button" onclick="test_async_dialog()" name="test_async"/>
             </body>
           </html>
         HTML
@@ -736,6 +916,88 @@ describe Capybara::Webkit::Driver do
 
       before { visit("/") }
 
+      it 'accepts any prompt modal if no match is provided' do
+        driver.accept_modal(:prompt) do
+          driver.find_xpath("//input").first.click
+        end
+        driver.console_messages.first[:message].should eq "hello John Smith"
+      end
+
+      it 'accepts any prompt modal with the provided response' do
+        driver.accept_modal(:prompt, with: 'Capy') do
+          driver.find_xpath("//input").first.click
+        end
+        driver.console_messages.first[:message].should eq "hello Capy"
+      end
+
+      it 'raises an error when accepting a prompt modal that does not match' do
+        expect {
+          driver.accept_modal(:prompt, text: 'Your age?') do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog with Your age?"
+      end
+
+      it 'dismisses any prompt modal if no match is provided' do
+        driver.dismiss_modal(:prompt) do
+          driver.find_xpath("//input").first.click
+        end
+        driver.console_messages.first[:message].should eq "goodbye"
+      end
+
+      it 'dismisses a prompt modal that does not match' do
+        begin
+          driver.accept_modal(:prompt, text: 'Your age?') do
+            driver.find_xpath("//input").first.click
+            driver.console_messages.first[:message].should eq "goodbye"
+          end
+        rescue Capybara::ModalNotFound
+        end
+      end
+
+      it 'raises an error when dismissing a prompt modal that does not match' do
+        expect {
+          driver.dismiss_modal(:prompt, text: 'Your age?') do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog with Your age?"
+      end
+
+      it 'waits to accept an async prompt modal' do
+        visit("/async")
+        prompt_message = driver.accept_modal(:prompt) do
+          driver.find_css("input[name=test_async]").first.click
+        end
+        prompt_message.should eq "Your name?"
+      end
+
+      it 'allows the nesting of dismiss and accept' do
+        driver.dismiss_modal(:prompt) do
+          driver.accept_modal(:prompt) do
+            driver.find_css("input[name=test_complex]").first.click
+          end
+        end
+        driver.console_messages.first[:message].should eq "goodbye"
+      end
+
+      it 'raises an error when an unexpected modal is displayed' do
+        expect {
+          driver.accept_modal(:confirm) do
+            driver.find_xpath("//input").first.click
+          end
+        }.to raise_error Capybara::ModalNotFound, "Unable to find modal dialog"
+      end
+
+      it 'dismisses a prompt modal when confirm is expected' do
+        begin
+          driver.accept_modal(:confirm) do
+            driver.find_xpath("//input").first.click
+            driver.console_messages.first[:message].should eq "goodbye"
+          end
+        rescue Capybara::ModalNotFound
+        end
+      end
+
       it "should default to dismiss the prompt" do
         driver.find_xpath("//input").first.click
         driver.console_messages.first[:message].should eq "goodbye"
@@ -1763,6 +2025,75 @@ describe Capybara::Webkit::Driver do
     end
   end
 
+  context "offline application cache" do
+    let(:driver) do
+      @visited = []
+      visited = @visited
+
+      driver_for_app do
+        get '/8d853f09-4275-409d-954d-ebbf6e2ce732' do
+          content_type 'text/cache-manifest'
+          visited << 'manifest'
+          <<-TEXT
+CACHE MANIFEST
+/4aaffa31-f42d-403e-a19e-6b248d608087
+          TEXT
+        end
+
+        # UUID urls so that this gets isolated from other tests
+        get '/f8742c39-8bef-4196-b1c3-80f8a3d65f3e' do
+          visited << 'complex'
+          <<-HTML
+            <html manifest="/8d853f09-4275-409d-954d-ebbf6e2ce732">
+              <body>
+                <span id='state'></span>
+                <span id='finished'></span>
+                <script type="text/javascript">
+                  document.getElementById("state").innerHTML = applicationCache.status;
+                  applicationCache.addEventListener('cached', function() {
+                    document.getElementById("finished").innerHTML = 'cached';
+                  });
+                  applicationCache.addEventListener('error', function() {
+                    document.getElementById("finished").innerHTML = 'error';
+                  });
+                </script>
+              </body>
+            </html>
+          HTML
+        end
+
+        get '/4aaffa31-f42d-403e-a19e-6b248d608087' do
+          visited << 'simple'
+          <<-HTML
+            <html manifest="/8d853f09-4275-409d-954d-ebbf6e2ce732">
+              <body>
+              </body>
+            </html>
+          HTML
+        end
+      end
+    end
+
+    before { visit("/f8742c39-8bef-4196-b1c3-80f8a3d65f3e") }
+
+    it "has proper state available" do
+      driver.find_xpath("//*[@id='state']").first.visible_text.should == '0'
+      sleep 1
+      @visited.should eq(['complex', 'manifest', 'simple']), 'files were not downloaded in expected order'
+      driver.find_xpath("//*[@id='finished']").first.visible_text.should == 'cached'
+    end
+
+    it "is cleared on driver reset!" do
+      sleep 1
+      @visited.should eq(['complex', 'manifest', 'simple']), 'files were not downloaded in expected order'
+      driver.reset!
+      @visited.clear
+      visit '/4aaffa31-f42d-403e-a19e-6b248d608087'
+      sleep 1
+      @visited.should eq(['simple', 'manifest', 'simple']), 'simple action was used from cache instead of server'
+    end
+  end
+
   context "form app with server-side handler" do
     let(:driver) do
       driver_for_app do
@@ -2185,6 +2516,7 @@ describe Capybara::Webkit::Driver do
               <iframe src="http://example.com/path" id="frame1"></iframe>
               <iframe src="http://example.org/path/to/file" id="frame2"></iframe>
               <iframe src="/frame" id="frame3"></iframe>
+              <iframe src="http://example.org/foo/bar" id="frame4"></iframe>
             </body>
           </html>
           HTML
@@ -2210,6 +2542,7 @@ describe Capybara::Webkit::Driver do
 
     before do
       driver.browser.url_blacklist = ["http://example.org/path/to/file",
+                                      "http://example.*/foo/*",
                                       "http://example.com",
                                       "#{AppRunner.app_host}/script"]
     end
@@ -2240,6 +2573,13 @@ describe Capybara::Webkit::Driver do
       end
     end
 
+    it "should not fetch urls blocked by wildcard match" do
+      visit('/')
+      driver.within_frame('frame4') do
+        driver.find("//body").first.text.should be_empty
+      end
+    end
+
     it "returns a status code for blocked urls" do
       visit("/")
       driver.within_frame('frame1') do