frameworks-capybara 0.2.30 → 0.2.31

data/CHANGES

@@ -1,3 +1,6 @@
+0.2.31
+Added Firefox profile certificate handling via the FIREFOX_CERT_PATH and FIREFOX_CERT_PREFIX variables.
+
 0.2.30
 Fixed rake profiles listings to work with Ruby 1.9+
 

data/Gemfile

@@ -4,6 +4,6 @@ platforms :jruby do
   gem "jruby-openssl"
 end
 
-gem "rspec-mocks"
+gem "rspec-mocks", "<2.14.0"
 
 gemspec

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    frameworks-capybara (0.2.30)
+    frameworks-capybara (0.2.31)
       capybara (~> 1.1.2)
       capybara-celerity
       capybara-mechanize (>= 0.3.0)
       cucumber (>= 0.10.5)
       headless
       json
+      mime-types (~> 1.25)
       nokogiri (~> 1.5.10)
       rubyzip (~> 0.9.9)
       w3c_validators
@@ -32,16 +33,16 @@ GEM
     celerity (0.9.2)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
-    cucumber (1.3.8)
+    cucumber (1.3.10)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12.1)
+      gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.0.2)
     diff-lcs (1.1.3)
-    domain_name (0.5.14)
+    domain_name (0.5.15)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.9.0)
+    ffi (1.9.3)
     gherkin (2.12.2)
       multi_json (~> 1.3)
     headless (1.0.1)
@@ -82,7 +83,7 @@ GEM
       multi_json (~> 1.0)
       rubyzip (< 1.0.0)
       websocket (~> 1.0.4)
-    unf (0.1.2)
+    unf (0.1.3)
       unf_ext
     unf_ext (0.0.6)
     w3c_validators (1.2)
@@ -101,4 +102,4 @@ DEPENDENCIES
   jruby-openssl
   rake
   rspec (>= 1.0.0)
-  rspec-mocks
+  rspec-mocks (< 2.14.0)

data/README.rdoc

@@ -37,6 +37,8 @@ The following environment variables can be set to configure your tests:
   REMOTE_URL - URL of remote Selenium-Webdriver server e.g. http://yourremotehost:4444/wd/hub
   FIREFOX_PROFILE - specify a firefox profile to use when running in-browser tests (local or remote)
   FIREFOX_PREFS - specify a json string of additional preferences e.g. FIREFOX_PREFS='{"javascript.enabled": false}'
+  FIREFOX_CERT_PATH - specify optional directory containing Firefox profile certificate (.db) files
+  FIREFOX_CERT_PREFIX - specify optional prefix for locating Firefox profile certificate files (e.g. <prefix>-<file>.db)
   CREATE_NEW_FF_PROFILE - create a new Firefox profile with name provided by FIREFOX_PROFILE 
   CELERITY_JS_ENABLED (string - 'true', 'false') - determines whether Celerity (HTMLUnit) attempts to execute javascript 
   XVFB - (string - 'true', 'false') - determines whether XVFB is used to run browser (i.e. headless Firefox on *nix platform)

data/frameworks-capybara.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
 
+  s.add_runtime_dependency("mime-types", ["~>1.25"])
   s.add_runtime_dependency("nokogiri", ["~>1.5.10"])
   s.add_runtime_dependency("rubyzip", ["~>0.9.9"])
   s.add_runtime_dependency("capybara", ["~>1.1.2"])

data/lib/frameworks/capybara.rb

@@ -32,10 +32,14 @@ class CapybaraSetup
     selenium_remote_opts = {:platform => ENV['PLATFORM'],
       :browser_name => ENV['REMOTE_BROWSER'],
       :version => ENV['REMOTE_BROWSER_VERSION'],
-      :url => ENV['REMOTE_URL']}
+      :url => ENV['REMOTE_URL']
+    }
 
     custom_opts = {:job_name => ENV['SAUCE_JOB_NAME'],
-      :max_duration => ENV['SAUCE_MAX_DURATION']}
+      :max_duration => ENV['SAUCE_MAX_DURATION'],
+      :firefox_cert_path => ENV['FIREFOX_CERT_PATH'],
+      :firefox_cert_prefix => ENV['FIREFOX_CERT_PREFIX']
+    }
 
     validate_env_vars(capybara_opts.merge(selenium_remote_opts)) #validate environment variables set using cucumber.yml or passed via command line
 
@@ -80,11 +84,39 @@ class CapybaraSetup
     end
   end
 
+  # WARNING: This modifies the Firefox profile passed in the parameters
+  def update_firefox_profile_with_certificates(profile, certificate_path, certificate_prefix = '')
+    profile_path = profile.layout_on_disk
+    
+    # Create links to the certificate files in the profile directory
+    ['cert8.db', 'key3.db', 'secmod.db'].each do |cert_file|
+      source_file = "#{certificate_prefix}#{cert_file}"
+      source_path = "#{certificate_path}" + File::SEPARATOR + source_file
+      dest_path = profile_path + File::SEPARATOR + cert_file
+      if(! File.exist?(source_path))
+        raise "Firefox cert db file #{source_path} does not exist."
+      end
+      FileUtils.cp(source_path, dest_path)
+    end 
+
+    # Force the certificates to get pulled into the profile
+    profile = Selenium::WebDriver::Firefox::Profile.new(profile_path)
+
+    # Avoid Firefox certificate alerts
+    profile["security.default_personal_cert"] = 'Select Automatically'
+    
+    return profile
+  end
+
   def register_selenium_driver(opts,remote_opts,custom_opts)
     Capybara.register_driver :selenium do |app|
 
       if opts[:firefox_prefs] || opts[:profile]
         opts[:profile] = create_profile(opts[:profile], opts[:firefox_prefs])
+
+        if custom_opts[:firefox_cert_path]
+          opts[:profile] = update_firefox_profile_with_certificates(opts[:profile], custom_opts[:firefox_cert_path], custom_opts[:firefox_cert_prefix])
+        end
       end
 
       opts[:switches] = [opts.delete(:chrome_switches)] if(opts[:chrome_switches])

data/lib/version.rb

@@ -1,3 +1,3 @@
 module FrameworksCapybara
-  VERSION = '0.2.30'
+  VERSION = '0.2.31'
 end

data/spec/frameworks_capybara_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'securerandom'
 ##
 #Monkey Patch
 #This is required because Capybara has module methods (singletons) which create
@@ -448,6 +449,138 @@ describe CapybaraSetup do
           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
+
+          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 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 = nil
+            setup.instance_exec(profile, @cert_dir, result) { |profile, certificate_path, result|
+              result = 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 = nil
+            setup.instance_exec(profile, @cert_dir, cert_prefix, result) { |profile, certificate_path, certificate_prefix, result|
+              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
 
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frameworks-capybara
 version: !ruby/object:Gem::Version 
-  hash: 43
+  hash: 41
   prerelease: false
   segments: 
   - 0
   - 2
-  - 30
-  version: 0.2.30
+  - 31
+  version: 0.2.31
 platform: ruby
 authors: 
 - matt robbins
@@ -15,13 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-23 00:00:00 +01:00
+date: 2013-11-19 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 1
+        - 25
+        version: "1.25"
+  name: mime-types
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,11 +48,11 @@ dependencies:
         - 10
         version: 1.5.10
   name: nokogiri
-  requirement: *id001
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,11 +64,11 @@ dependencies:
         - 9
         version: 0.9.9
   name: rubyzip
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,11 +80,11 @@ dependencies:
         - 2
         version: 1.1.2
   name: capybara
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -81,11 +96,11 @@ dependencies:
         - 0
         version: 0.3.0
   name: capybara-mechanize
-  requirement: *id004
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,11 +110,11 @@ dependencies:
         - 0
         version: "0"
   name: json
-  requirement: *id005
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -109,11 +124,11 @@ dependencies:
         - 0
         version: "0"
   name: headless
-  requirement: *id006
+  requirement: *id007
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -123,11 +138,11 @@ dependencies:
         - 0
         version: "0"
   name: capybara-celerity
-  requirement: *id007
+  requirement: *id008
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -137,11 +152,11 @@ dependencies:
         - 0
         version: "0"
   name: w3c_validators
-  requirement: *id008
+  requirement: *id009
 - !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -153,11 +168,11 @@ dependencies:
         - 5
         version: 0.10.5
   name: cucumber
-  requirement: *id009
+  requirement: *id010
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -167,11 +182,11 @@ dependencies:
         - 0
         version: "0"
   name: rake
-  requirement: *id010
+  requirement: *id011
 - !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -183,7 +198,7 @@ dependencies:
         - 0
         version: 1.0.0
   name: rspec
-  requirement: *id011
+  requirement: *id012
 description: Gem to ease the pain of managing capybara driver config and provide a home for common utils and patches
 email: 
 - mcrobbins@gmail.com