RubyGems - frameworks-capybara - Versions diffs - 0.3.0.rc5 → 1.0.0 - Mend

frameworks-capybara 0.3.0.rc5 → 1.0.0

Files changed (20) hide show

checksums.yaml +15 -0
data/.travis.yml +2 -6
data/CHANGES +52 -0
data/Gemfile +3 -1
data/Gemfile.lock +59 -52
data/README.rdoc +19 -4
data/frameworks-capybara.gemspec +7 -3
data/lib/frameworks/capybara.rb +39 -16
data/lib/frameworks/cucumber.rb +58 -33
data/lib/monkey-patches/capybara-mechanize-patches.rb +30 -9
data/lib/monkey-patches/cucumber-patches.rb +5 -1
data/lib/monkey-patches/mechanize-patches.rb +17 -4
data/lib/tasks/frameworks-tasks.rb +1 -1
data/lib/version.rb +1 -1
data/spec/capybara_mechanize_patches_spec.rb +124 -0
data/spec/frameworks_capybara_spec.rb +127 -12
data/spec/frameworks_cucumber_spec.rb +114 -3
data/spec/spec_helper.rb +1 -0
metadata +209 -179
data/lib/monkey-patches/capybara-webkit-patches.rb +0 -26

data/lib/monkey-patches/cucumber-patches.rb CHANGED Viewed

@@ -7,7 +7,11 @@ module Cucumber
         @project_name = ENV['PROJECT_NAME'] || ''
         unless @project_name.empty? then @project_name += ' - ' end
-        @step_count = get_step_count(features)
+        if Cucumber::Ast::Feature.method_defined?(:step_count)
+          @step_count = features.step_count # cucumber >=1.3.0
+        else
+          @step_count = get_step_count(features) # cucumber <1.3.0
+        end
         # <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
         @builder.declare!(

data/lib/monkey-patches/mechanize-patches.rb CHANGED Viewed

@@ -4,9 +4,9 @@ require 'mechanize'
 #we check after response and it may be the last response we need it to clear here.
 class Mechanize::CookieJar
   alias_method :old_add, :add
-  def add(uri, cookie)
+  def add(*args)
     cleanup
-    old_add(uri, cookie)
+    old_add(*args)
   end
 end
 #This patch may still be required, think it is only not needed now because we don't run
@@ -58,8 +58,17 @@ end
 =end
 # This patch prevents Mechanize from raising a Mechanize::ResponseCodeError
-# when the HTTP Response Code is 503 or 404. This lets capybara continue the journey.
+# when the HTTP Response Code is in `allowed_error_codes`.
+# https://github.com/tenderlove/mechanize/pull/248
 class Mechanize::HTTP::Agent
+  attr_accessor :allowed_error_codes
+  alias_method :old_initialize, :initialize
+  def initialize
+    @allowed_error_codes      = []
+    old_initialize
+  end
   def fetch uri, method = :get, headers = {}, params = [],
             referer = current_page, redirects = 0
     referer_uri = referer ? referer.uri : nil
@@ -156,7 +165,11 @@ class Mechanize::HTTP::Agent
                             referer)
     else
       # BEGIN PATCH
-      if page.code == "503" or page.code == "404"
+      if @allowed_error_codes.any? {|code| code.to_s == page.code} then
+        if robots && page.is_a?(Mechanize::Page)
+          page.parser.noindex? and raise Mechanize::RobotsDisallowedError.new(uri)
+        end
         page
       else
         raise Mechanize::ResponseCodeError.new(page, 'unhandled response')

data/lib/tasks/frameworks-tasks.rb CHANGED Viewed

@@ -24,7 +24,7 @@ class RakeHelpers
       f =  File.open('config/cucumber.yml', 'r')
       linenum = 0
       @profiles = {}
-      f.read.each do |line|
+      f.readlines.each do |line|
         line.scan(/.*?: /) do |match|
           linenum += 1
           puts color(linenum.to_s + '. ', :color => :yellow) + color(match.gsub(':',''), :color => :green)

data/lib/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module FrameworksCapybara
-  VERSION = '0.3.0.rc5'
+  VERSION = '1.0.0'
 end

data/spec/capybara_mechanize_patches_spec.rb ADDED Viewed

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'rspec/mocks/mock'
+require 'uri'
+describe Capybara::Mechanize::Browser do
+  RSpec::Mocks::setup(self)
+  it "shouldn't send referer if unknown" do
+    agent = double()
+    agent.stub('get' => true)
+    agent.should_receive('get').with(
+      "http://example.bbc.co.uk/test",
+      {},
+      nil,
+      {}
+    )
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:get, 'http://example.bbc.co.uk/test', {}, {})
+  end
+  it "should not change behaviour for POST requests" do
+    agent = double()
+    agent.stub('post' => true)
+    agent.should_receive('post').with("http://example.bbc.co.uk/test")
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "http://example.bbc.co.uk/blah")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:post, 'http://example.bbc.co.uk/test', {}, {})
+  end
+  it "should not send referer for requests from HTTPs to HTTP" do
+    agent = double()
+    agent.stub('get' => true)
+    agent.should_receive('get').with(
+      "http://example.bbc.co.uk/test",
+      {},
+      nil,
+      {}
+    )
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "https://example.bbc.co.uk/blah")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:get, 'http://example.bbc.co.uk/test', {}, {})
+  end
+  it "should send referer for requests from HTTP to HTTPs" do
+    agent = double()
+    agent.stub('get' => true)
+    agent.should_receive('get').with(
+      "https://example.bbc.co.uk/test",
+      {},
+      "http://example.bbc.co.uk/blah",
+      {}
+    )
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "http://example.bbc.co.uk/blah")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:get, 'https://example.bbc.co.uk/test', {}, {})
+  end
+  it "should send referer for requests from HTTP to HTTP" do
+    agent = double()
+    agent.stub('get' => true)
+    agent.should_receive('get').with(
+      "http://example.bbc.co.uk/test",
+      {},
+      "http://example.bbc.co.uk/blah",
+      {}
+    )
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "http://example.bbc.co.uk/blah")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:get, 'http://example.bbc.co.uk/test', {}, {})
+  end
+  it "should send referer for requests from HTTPs to HTTPs" do
+    agent = double()
+    agent.stub('get' => true)
+    agent.should_receive('get').with(
+      "https://example.bbc.co.uk/test",
+      {},
+      "https://example.bbc.co.uk/blah",
+      {}
+    )
+    driver = double("Capybara::Mechanize::Driver")
+    browser = Capybara::Mechanize::Browser.new(driver)
+    browser.stub('current_url' => "https://example.bbc.co.uk/blah")
+    browser.stub('agent' => agent)
+    browser.process_remote_request(:get, 'https://example.bbc.co.uk/test', {}, {})
+  end
+end

data/spec/frameworks_capybara_spec.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'securerandom'
 ##
 #Monkey Patch
 #This is required because Capybara has module methods (singletons) which create
@@ -116,7 +117,7 @@ describe CapybaraSetup do
         before do
           ENV['BROWSER'] = 'firefox'
           ENV['FIREFOX_PROFILE'] = 'BBC_INTERNAL'
-          ENV['HTTP_PROXY'] = 'http://example.cache.co.uk:80'
+          ENV['HTTP_PROXY'] = 'http://example.cache.co.uk:80/'
           ENV['PROXY_ON'] = 'false'
         end
@@ -127,7 +128,7 @@ describe CapybaraSetup do
           Capybara.current_session.driver.options[:browser].should == :firefox
           Capybara.current_session.driver.options[:profile].should be_a_kind_of Selenium::WebDriver::Firefox::Profile
           Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.type'].should == 1
-          Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.no_proxies_on'].should == '*.sandbox.dev.bbc.co.uk'
+          Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.no_proxies_on'].should == '*.sandbox.dev.bbc.co.uk,*.sandbox.bbc.co.uk'
           Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.http'].should == 'example.cache.co.uk'
           Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.http_port'].should == 80
           Capybara.current_session.driver.options[:profile].instance_variable_get(:@additional_prefs)['network.proxy.ssl'].should == 'example.cache.co.uk'
@@ -216,7 +217,7 @@ describe CapybaraSetup do
           Capybara.current_session.driver.options[:browser].should == :remote
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].should be_a_kind_of Selenium::WebDriver::Firefox::Profile
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.type'].should == 1
-          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.no_proxies_on'].should == '*.sandbox.dev.bbc.co.uk'
+          Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.no_proxies_on'].should == '*.sandbox.dev.bbc.co.uk,*.sandbox.bbc.co.uk'
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.http'].should == 'example.cache.co.uk'
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.http_port'].should == 80
           Capybara.current_session.driver.options[:desired_capabilities].instance_variable_get(:@capabilities)[:firefox_profile].instance_variable_get(:@additional_prefs)['network.proxy.ssl'].should == 'example.cache.co.uk'
@@ -448,23 +449,137 @@ describe CapybaraSetup do
           end
         end
-      end
+        context "integration tests for update_firefox_profile_with_certificates() method" do
+          before do
+            def write_random_data(file_path)
+              file_data = SecureRandom.hex
+              File.open(file_path, "w") { |a_file|
+                a_file.write(file_data)
+              }
+              file_data
+            end
+            def compare_file_data(profile_path, file_name, expected_data)
+              profile_file = profile_path + File::SEPARATOR + file_name
+              actual_data = nil
+              File.open(profile_file, "r") { |a_file|
+                actual_data = a_file.read
+              }
+              expected_data.should == actual_data
+            end
+            ENV['BROWSER'] = 'firefox'
+            ENV['ENVIRONMENT'] = 'test'
+            ENV['HTTP_PROXY'] = 'http://example.cache.co.uk:80'
+            @cert_dir = Dir.mktmpdir
+            @cert8_db = @cert_dir + File::SEPARATOR + 'cert8.db'
+            @key3_db = @cert_dir + File::SEPARATOR + 'key3.db'
+            @secmod_db = @cert_dir + File::SEPARATOR + 'secmod.db'
+          end
+          after do
+            FileUtils.remove_entry @cert_dir
+          end
-      describe "should allow Webkit driver to be created" do
-        context "with minimal Webkit driver" do
-          before do
-            ENV['BROWSER'] = 'webkit'
+          it "should raise an exception if the cert8.db file is missing in the source directory" do
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            key3_data = write_random_data(@key3_db)
+            secmod_data = write_random_data(@secmod_db)
+            an_exception = nil
+            begin
+              CapybaraSetup.new.instance_exec(profile, @cert_dir) { |profile, certificate_path|
+                update_firefox_profile_with_certificates(profile, certificate_path)
+              }
+            rescue RuntimeError => e
+              an_exception = e
+            end
+            an_exception.should_not be_nil
           end
-          it "should be initialized correctly" do
-            Capybara.delete_session
-            CapybaraSetup.new.driver.should == :webkit
-            Capybara.current_session.driver.should be_a_kind_of Capybara::Driver::Webkit
+          it "should raise an exception if the key3.db file is missing in the source directory" do
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            cert8_data = write_random_data(@cert8_db)
+            secmod_data = write_random_data(@secmod_db)
+            an_exception = nil
+            begin
+              CapybaraSetup.new.instance_exec(profile, @cert_dir) { |profile, certificate_path|
+                update_firefox_profile_with_certificates(profile, certificate_path)
+              }
+            rescue RuntimeError => e
+              an_exception = e
+            end
+            an_exception.should_not be_nil
+          end
+          it "should raise an exception if the secmod.db file is missing in the source directory" do
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            cert8_data = write_random_data(@cert8_db)
+            key3_data = write_random_data(@key3_db)
+            an_exception = nil
+            begin
+              CapybaraSetup.new.instance_exec(profile, @cert_dir) { |profile, certificate_path|
+                update_firefox_profile_with_certificates(profile, certificate_path)
+              }
+            rescue RuntimeError => e
+              an_exception = e
+            end
+            an_exception.should_not be_nil
+          end
+          it "should update a firefox profile with valid references to certificate db files" do
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            cert8_data = write_random_data(@cert8_db)
+            key3_data = write_random_data(@key3_db)
+            secmod_data = write_random_data(@secmod_db)
+            setup = CapybaraSetup.new
+            result = setup.instance_exec(profile, @cert_dir) { |profile, certificate_path|
+              update_firefox_profile_with_certificates(profile, certificate_path)
+            }
+            profile_path = result.layout_on_disk
+            compare_file_data(profile_path, 'cert8.db', cert8_data)
+            compare_file_data(profile_path, 'key3.db', key3_data)
+            compare_file_data(profile_path, 'secmod.db', secmod_data)
           end
+          it "should update a firefox profile with references to certificate db files with prefixes" do
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            cert_prefix = 'a'
+            @cert8_db = @cert_dir + File::SEPARATOR + cert_prefix + 'cert8.db'
+            @key3_db = @cert_dir + File::SEPARATOR + cert_prefix + 'key3.db'
+            @secmod_db = @cert_dir + File::SEPARATOR + cert_prefix + 'secmod.db'
+            cert8_data = write_random_data(@cert8_db)
+            key3_data = write_random_data(@key3_db)
+            secmod_data = write_random_data(@secmod_db)
+            setup = CapybaraSetup.new
+            result = setup.instance_exec(profile, @cert_dir, cert_prefix) { |profile, certificate_path, certificate_prefix, result|
+              update_firefox_profile_with_certificates(profile, certificate_path, certificate_prefix)
+            }
+            profile_path = result.layout_on_disk
+            compare_file_data(profile_path, 'cert8.db', cert8_data)
+            compare_file_data(profile_path, 'key3.db', key3_data)
+            compare_file_data(profile_path, 'secmod.db', secmod_data)
+          end
         end
       end
     end
   end
 end

data/spec/frameworks_cucumber_spec.rb CHANGED Viewed

@@ -20,6 +20,16 @@ describe Frameworks::EnvHelper do
       @mobile_base_url.should == 'http://mobile.sandbox.dev.bbc.co.uk'
     end
+    it "should be able to set a local system6 url" do
+      ENV['ENVIRONMENT'] = 'sandbox6'
+      generate_base_urls
+      @base_url.should == 'http://sandbox.bbc.co.uk'
+      @ssl_base_url.should == 'https://ssl.sandbox.bbc.co.uk'
+      @static_base_url.should == 'http://static.sandbox.bbc.co.uk'
+      @m_base_url.should == 'http://m.sandbox.bbc.co.uk'
+      @mobile_base_url.should == 'http://mobile.sandbox.bbc.co.uk'
+    end
     it "should be able to set a base url" do
       ENV['ENVIRONMENT'] = 'foo'
       generate_base_urls
@@ -114,27 +124,128 @@ describe Frameworks::EnvHelper do
       @open_base_url.should == 'https://open.foo.bbc.co.uk'
     end
-    it "should be able to set proxy host correctly to use in tests using HTTP_PROXY env variable" do
+    it "should be able to set proxy host and port correctly to use in tests using HTTP_PROXY env variable" do
       ENV['ENVIRONMENT'] = 'foo'
-      ENV['HTTP_PROXY'] = 'http://mycache.co.uk:80'
+      ENV['HTTP_PROXY'] = 'http://mycache.co.uk:8080'
       generate_base_urls
       @proxy_host.should == "mycache.co.uk"
+      @proxy_port.should == "8080"
     end
     it "should be able to set proxy host correctly to use in tests using http_proxy env variable" do
       ENV['ENVIRONMENT'] = 'foo'
-      ENV['http_proxy'] = 'http://mycache.co.uk:80'
+      ENV['http_proxy'] = 'http://mycache.co.uk:8080'
+      generate_base_urls
+      @proxy_host.should == "mycache.co.uk"
+      @proxy_port.should == "8080"
+    end
+    it "should be able to use 80 as default proxy port when none specified" do
+      ENV['ENVIRONMENT'] = 'foo'
+      ENV['http_proxy'] = 'http://mycache.co.uk'
+      generate_base_urls
+      @proxy_host.should == "mycache.co.uk"
+      @proxy_port.should == "80"
+    end
+    it "should be able to handle an environment variable which doesn't have the protocol" do
+      ENV['ENVIRONMENT'] = 'foo'
+      ENV['http_proxy'] = 'mycache.co.uk'
       generate_base_urls
       @proxy_host.should == "mycache.co.uk"
+      @proxy_port.should == "80"
+    end
+    it "should be able to have an empty http_proxy environment variable" do
+      ENV['ENVIRONMENT'] = 'foo'
+      ENV['http_proxy'] = ''
+      generate_base_urls
+      @proxy_host.should be_nil
+      @proxy_port.should be_nil
+    end
+    it "should be able to set a local url with expected domain" do
+      ENV['ENVIRONMENT'] = 'sandbox'
+      ENV['FW_BBC_DOMAIN'] = 'bbc.com'
+      generate_base_urls
+      @base_url.should == 'http://pal.sandbox.dev.bbc.com'
+      @ssl_base_url.should == 'https://ssl.sandbox.dev.bbc.com'
+      @static_base_url.should == 'http://static.sandbox.dev.bbc.com'
+      @m_base_url.should == 'http://m.sandbox.dev.bbc.com'
+      @mobile_base_url.should == 'http://mobile.sandbox.dev.bbc.com'
+    end
+    it "should be able to set a local system6 url with expected domain" do
+      ENV['ENVIRONMENT'] = 'sandbox6'
+      ENV['FW_BBC_DOMAIN'] = 'bbc.com'
+      generate_base_urls
+      @base_url.should == 'http://sandbox.bbc.com'
+      @ssl_base_url.should == 'https://ssl.sandbox.bbc.com'
+      @static_base_url.should == 'http://static.sandbox.bbc.com'
+      @m_base_url.should == 'http://m.sandbox.bbc.com'
+      @mobile_base_url.should == 'http://mobile.sandbox.bbc.com'
+    end
+    it "should be able to set a base url with expected domain" do
+      ENV['ENVIRONMENT'] = 'foo'
+      ENV['FW_BBC_DOMAIN'] = 'bbc.com'
+      generate_base_urls
+      @base_url.should == 'http://www.foo.bbc.com'
+      @ssl_base_url.should == 'https://ssl.foo.bbc.com'
+      @static_base_url.should == 'http://static.foo.bbci.co.uk'
+      @open_base_url.should == 'http://open.foo.bbc.com'
+      @m_base_url.should == 'http://m.foo.bbc.com'
+      @mobile_base_url.should == 'http://mobile.foo.bbc.com'
+    end
+    it "should set public facing live domain" do
+      ENV['ENVIRONMENT'] = 'live'
+      ENV['WWW_LIVE'] = 'false'
+      ENV['FW_BBC_DOMAIN'] = 'bbc.com'
+      generate_base_urls
+      @base_url.should == 'http://www.bbc.com'
+      @ssl_base_url.should == 'https://ssl.bbc.com'
+      @static_base_url.should == 'http://static.bbci.co.uk'
+      @open_base_url.should == 'http://open.bbc.com'
+      @m_base_url.should == 'http://m.bbc.com'
+      @mobile_base_url.should == 'http://mobile.bbc.com'
     end
 =begin
 #don't want to push proxy addr online
     it "should be able to validate xhtml online" do
       @proxy_host = ''
+      @proxy_port = ''
       xhtml = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><title>a</title></head><body><p>a</p></body></html>'
       validate_online(xhtml)
     end
+    it "should be able to report errors for invalid markup" do
+      @proxy_host = ''
+      @proxy_port = ''
+      xhtml = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><nosuchelement><title>a</title></head><body><p>a</p></body></html>'
+      expect {
+        validate_online(xhtml)
+      }.to raise_error(RuntimeError)
+    end
 =end
+  end
+    describe "independent mechanize agent" do
+    include Frameworks::EnvHelper
+    it "should allow you to create an independent, configured mechanize object" do
+      ENV['HTTP_PROXY'] = 'http://mycache.co.uk:80'
+      agent = new_mechanize
+      agent.should be_a_kind_of Mechanize
+      agent.proxy_addr.should == 'mycache.co.uk'
+    end
+    it "the proxy should be separately configurable" do
+      agent = new_mechanize(http_proxy='http://mycache.co.uk:80')
+      agent.should be_a_kind_of Mechanize
+      agent.proxy_addr.should == 'mycache.co.uk'
+    end
   end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -13,4 +13,5 @@ Cucumber::RbSupport::RbLanguage.new(Cucumber::Runtime.new) #Need to load Cucumbe
 require 'frameworks/capybara'
 require 'frameworks/cucumber'
+require 'monkey-patches/capybara-mechanize-patches'
 require 'unit_test_monkeypatches.rb'